---
title: gluestack-ui Progress Component | Installation, Usage, and API

description: Track task progression across multiple steps, keeping users updated on lengthy processes.

pageTitle: Progress

pageDescription: Track task progression across multiple steps, keeping users updated on lengthy processes.

showHeader: true
---

import { Meta } from '@storybook/addon-docs';

<Meta title="with-nativewind/Components/Feedback/Progress" />


import { Progress, ProgressFilledTrack, VStack, Box, Heading } from '../../core-components/nativewind';
import { transformedCode } from '../../utils';
import {
  AppProvider,
  CodePreview,
  Text,
  Table,
  TableContainer,
  InlineCode,
  Tabs
} from '@gluestack/design-system';

import Wrapper from '../../core-components/nativewind/Wrapper';
import { CollapsibleCode } from '@gluestack/design-system';

This is an illustration of **Progress** component.

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={true}
    metaData={{
      code: `
       <Progress value={40} className="w-[300px]" {...props} >
          <ProgressFilledTrack />
        </Progress>
      `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: { Wrapper, Progress, ProgressFilledTrack },
      argsType: {
        size: {
          control: 'select',
          options: ['xs', 'sm', 'md', 'lg', 'xl', '2xl'],
          default: 'md',
        },
      },
    }}
  />
</Wrapper>

<br />

## Installation

<Tabs value="cli" type="section">
  <Tabs.TabList>
      <Tabs.Tab value="cli">
        <Tabs.TabTitle>CLI</Tabs.TabTitle>
      </Tabs.Tab>
     <Tabs.Tab value="manual">
        <Tabs.TabTitle>Manual</Tabs.TabTitle>
     </Tabs.Tab>
  </Tabs.TabList>
  <Tabs.TabPanels>
    <Tabs.TabPanel value="cli">
<>

### Run the following command:
  ```bash
  npx gluestack-ui add progress
  ```
</>
    </Tabs.TabPanel>
    <Tabs.TabPanel value="manual"> 
<>

### Step 1: Install the following dependencies:
```bash
npm i @gluestack-ui/progress
```

### Step 2: Copy and paste the following code into your project.
<CollapsibleCode>

```jsx 
%%-- File: core-components/nativewind/progress/index.tsx --%% 
```
</CollapsibleCode>

### Step 3: Update the import paths to match your project setup.
</>
    </Tabs.TabPanel>
  </Tabs.TabPanels>
</Tabs>

## API Reference

To use this component in your project, include the following import statement in your file.

```jsx
import { Progress, ProgressFilledTrack } from '@/components/ui/progress';
```

```jsx
export default () => (
  <Progress>
    <ProgressFilledTrack />
  </Progress>
);
```

### Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

#### Progress

It inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.

<>
  <TableContainer>
    <Table>
      <Table.THead>
        <Table.TR>
          <Table.TH>
            <Table.TText>Prop</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Type</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Default</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Description</Table.TText>
          </Table.TH>
        </Table.TR>
      </Table.THead>
      <Table.TBody>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>value</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>number</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>-</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>{`It is used to set the progress of the progress bar`}</Table.TText>
          </Table.TD>
        </Table.TR>
      </Table.TBody>
    </Table>
  </TableContainer>
</>

#### ProgressFilledTrack

It also inherits all the properties of React Native's [View](https://reactnative.dev/docs/view) component.

### Accessibility

We have outlined the various features that ensure the Fab component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards. Adheres to the [WAI-ARIA design pattern](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/progressbar_role).

#### Keyboard

- Tab: Moves focus to the next focusable element.

#### Screen Reader

- VoiceOver: When the Progress is focused, the screen reader will announce it's a progress and it's current progress indicator.

### Props

Progress component is created using View component from react-native. It extends all the props supported by [React Native View](https://reactnative.dev/docs/view#props).

#### Progress

<>
  <TableContainer>
    <Table>
      <Table.THead>
        <Table.TR>
          <Table.TH>
            <Table.TText>Name</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Value</Table.TText>
          </Table.TH>
          <Table.TH>
            <Table.TText>Default</Table.TText>
          </Table.TH>
        </Table.TR>
      </Table.THead>
      <Table.TBody>
        <Table.TR>
          <Table.TD>
            <Table.TText>
              <InlineCode>size</InlineCode>
            </Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>xs | sm | md | lg | xl | 2xl</Table.TText>
          </Table.TD>
          <Table.TD>
            <Table.TText>md</Table.TText>
          </Table.TD>
        </Table.TR>
      </Table.TBody>
    </Table>
  </TableContainer>
</>

> Note: These props are exclusively applicable when utilizing the default configuration of gluestack-ui/config. If you are using a custom theme, these props may not be available.

### Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

#### Value

Progress component with value

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={false}
    metaData={{
      code: `
      <VStack space="lg">
        <Text size="lg">Downloading 55%</Text>
        <Progress value={55} className='w-80 h-1'>
          <ProgressFilledTrack className='h-1' />
        </Progress>
      </VStack>
    `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: {
        Wrapper,
        Progress,
        ProgressFilledTrack,
        VStack,
        Text,
        Box,
      },
      argsType: {},
    }}
  />
</Wrapper>

#### Color

You can add track color to progress bar as per our needs.

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={false}
    metaData={{
      code: `
        <VStack space="3xl">
          <Progress value={46} className='w-96 h-2' size="sm">
            <ProgressFilledTrack className='bg-emerald-600'/>
          </Progress>
          <Progress value={46} className='w-96 h-2' size="sm">
            <ProgressFilledTrack className='bg-amber-600'/>
          </Progress>
          <Progress value={46} className='w-96 h-2' size="sm">
            <ProgressFilledTrack className='bg-fuchsia-600'/>
          </Progress>
          <Progress value={46} className='w-96 h-2' size="sm">
            <ProgressFilledTrack className='bg-cyan-600'/>
          </Progress>
        </VStack>
      `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: {
        Wrapper,
        Progress,
        ProgressFilledTrack,
        VStack,
      },
      argsType: {},
    }}
  />
</Wrapper>

#### Custom

You can customize the progress bar. Below is the example where we have change the theme of progress bar.

<Wrapper>
  <CodePreview
    showComponentRenderer={true}
    showArgsController={false}
    metaData={{
      code: `
        <VStack space="lg">
        <Heading>Internal Storage</Heading>
        <Progress value={46} className='w-[410px] h-2 bg-lime-100'>
          <ProgressFilledTrack className='h-2 bg-lime-500' />
        </Progress>
        <Text size="md">14GB</Text>
        </VStack>
      `,
      transformCode: (code) => {
        return transformedCode(code);
      },
      scope: {
        Wrapper,
        Progress,
        ProgressFilledTrack,
        VStack,
        Heading,
        Text,
      },
      argsType: {},
    }}
  />
</Wrapper>
